Correct docs generation #252
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
gsmet
approved these changes
Nov 6, 2024
There was a problem hiding this comment.
Yes.
quarkus-config-doc-maven-plugin is only used in the docs module. That's where you need the version defined. And that's what it does with this commit given the the version in the pluginManagement of the root pom will be inherited by the docs module.
With the previous version, you were defining the version in modules where you didn't use the plugin.
Now, things can work for several reasons:
- if you enforce the version in the docs module directly when declaring the plugin
- if you're lucky enough that the latest version of the
quarkus-config-doc-maven-plugin(that's what Maven will use if no version is defined) is compatible with what the version of the extension annotation processor will produce. So it might work for a few versions and then suddenly get broken. It could also be broken in a subtle way that doesn't fail the build.
The version of quarkus-config-doc-maven-plugin should be the same as the version of the extension annotation processor.
|
Ahh, thanks @gsmet. It was probably picking up the latest, and that's why it seemed to work. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
See discussion in #236 (comment)
@gsmet, thank you for your help. Does this look better?
I think I now understand the intention of the changes :)
(... although I still don't understand how my previous version built cleanly.)